combine
Type
command
Summary
Transforms an array into a list.
Syntax
combine <arrayName> {using | by | with} <primaryDelimiter> [and <secondaryDelimiter>]
combine <arrayName> {using | by | with} <primaryDelimiter> as set
combine <arrayName> {using | by | with} {row | column}
Description
Use the combine command to display an array in a field or to process an array using string operators, functions, and chunk expressions.
The combine command combines the elements of the array into a single variable. After the command is finished executing, the variable specified by arrayName is no longer an array.
If the first form of the command is used, the elements of the original array are separated by the primaryDelimiter. For example, if the primaryDelimiter is return, the content of each element of the original array appears on a separate line.
If you specify a secondaryDelimiter, the key corresponding to each element is added to the element's content, separated from the content by the secondaryDelimiter. For example, if the primaryDelimiter is return and the secondaryDelimiter is tab, each line of the resulting variable contains an element's key, a tab character, and the element's content. If you don't specify a secondaryDelimiter, then the keys are lost in the transformation.
If you use the as set form the combine command rebuilds the list using
the delimiter passed; the values of the array are ignored.
If the second form of the combine command is used, the elements of the original array are considered to be either columns or rows, separated by the columnDelimiter or rowDelimiter property respectively.
Combining an array by row converts the array into a table with rows separated by the rowDelimiter. Each row in the resulting string is the contents of the corresponding key in the array.
Combining an array by column converts the array into a table with columns separated by the columnDelimiter property. Each column of the resulting string is the contents of the corresponding key in the array.
The combine by row and combine by column forms can only be used with numerically keyed arrays
The combine by row and combine with forms process the keys of the array in ascending, numeric order, if the array is a (numeric) sequence, and ascending case-sensitive string order otherwise.
Parameters
| Name | Type | Description |
|---|---|---|
primaryDelimiter | A character or expression that resolves to a character. | |
secondaryDelimiter | A character or expression that resolves to a character. | |
arrayName | array | An array variable. |
Examples
combine myArray using comma
combine myArray by row
local tArray
put "apple" into tArray[1]
put "banana" into tArray[2]
combine tArray using return and ":"
## RESULT tArray
## 1:apple
## 2:banana
Related
keyword: left-square-bracketright-square-bracket, using
operator: is a
property: columnDelimiter, rowDelimiter
command: intersect, sort, split, union
Compatibility and Support
Introduced
LiveCode 1.1
OS
mac
windows
linux
ios
android
web
Platforms
desktop
server
mobile